API Documentation
Public Member Functions | List of all members
nkGraphics::InputSystem Class Reference

The input system used within the component. More...

Public Member Functions

 InputSystem ()
 
 ~InputSystem ()
 
bool initialize ()
 
BaseKeyHandlergetKeyHandler () const
 
BaseMouseHandlergetMouseHandler () const
 
IDirectInput8 * getDirectInputSystem () const
 
void setKeyHandler (BaseKeyHandler *handler)
 
void setMouseHandler (BaseMouseHandler *handler)
 
void update ()
 

Detailed Description

The input system used within the component.

Note that it is highly probable this system will move into its own component in a near future.

Constructor & Destructor Documentation

◆ InputSystem()

nkGraphics::InputSystem::InputSystem ( )

Constructor. In theory, should not be called from external code. The system is currently made available through the MainSystem.

◆ ~InputSystem()

nkGraphics::InputSystem::~InputSystem ( )

Destructor.

Member Function Documentation

◆ initialize()

bool nkGraphics::InputSystem::initialize ( )

Initializes the system, to make it ready for updating.

Returns
If the initialization process went well.

◆ getKeyHandler()

BaseKeyHandler* nkGraphics::InputSystem::getKeyHandler ( ) const
Returns
The key handler used.

◆ getMouseHandler()

BaseMouseHandler* nkGraphics::InputSystem::getMouseHandler ( ) const
Returns
The mouse handler used.

◆ getDirectInputSystem()

IDirectInput8* nkGraphics::InputSystem::getDirectInputSystem ( ) const
Returns
The direct input system used internally.
Remarks
This function should not be used by external code. This function will disappear and this aspect of input will be abstracted once the system moves to its own component.

◆ setKeyHandler()

void nkGraphics::InputSystem::setKeyHandler ( BaseKeyHandler handler)

Sets the key handler to use when updating.

Parameters
handlerThe handler to use. External code is responsible for freeing it once it is unneeded.

◆ setMouseHandler()

void nkGraphics::InputSystem::setMouseHandler ( BaseMouseHandler handler)

Sets the mouse handler to use when updating.

Parameters
handlerThe handler to use. External code is responsible for freeing it once it is unneeded.

◆ update()

void nkGraphics::InputSystem::update ( )

Updates the input structures.


The documentation for this class was generated from the following file: